| API Documentation |  |

- MAIN PAGE
- NAMESPACES
- CLASSES

ComparisonFunction.h
1 // ComparisonFunction.h
3 //
5
6 namespace nkGraphics
7 {
11 enum class COMPARISON_FUNCTION
12 {
13 FUNCTION_NEVER = 1,
14 FUNCTION_LESS = 2,
15 FUNCTION_EQUAL = 3,
16 FUNCTION_LESS_EQUAL = 4,
17 FUNCTION_GREATER = 5,
18 FUNCTION_NOT_EQUAL = 6,
19 FUNCTION_GREATER_EQUAL = 7,
20 FUNCTION_ALWAYS = 8
21 } ;
22
26 class ComparisonFunctionUtils final
27 {
28 public :
29
30 // Conversions
37 static nkMemory::StringView toString (COMPARISON_FUNCTION value) ;
44 static COMPARISON_FUNCTION fromString (nkMemory::StringView value) ;
51 static COMPARISON_FUNCTION fromIndex (unsigned int value) ;
52 } ;
53 }
nkGraphics::COMPARISON_FUNCTION::FUNCTION_LESS
@ FUNCTION_LESS
Function < (less than).
nkGraphics::COMPARISON_FUNCTION::FUNCTION_GREATER
@ FUNCTION_GREATER
Function > (greater than).
nkGraphics::COMPARISON_FUNCTION::FUNCTION_ALWAYS
@ FUNCTION_ALWAYS
The function always passes.
nkGraphics::ComparisonFunctionUtils::fromString
static COMPARISON_FUNCTION fromString(nkMemory::StringView value)
nkGraphics::COMPARISON_FUNCTION::FUNCTION_NEVER
@ FUNCTION_NEVER
The function never passes.
nkMemory::StringView
Class holding information about a string, with no ownership over the data.
Definition: StringView.h:22
nkGraphics::COMPARISON_FUNCTION::FUNCTION_EQUAL
@ FUNCTION_EQUAL
Function == (equal).
nkGraphics::COMPARISON_FUNCTION::FUNCTION_NOT_EQUAL
@ FUNCTION_NOT_EQUAL
Function != (not equal).
nkGraphics::ComparisonFunctionUtils::fromIndex
static COMPARISON_FUNCTION fromIndex(unsigned int value)
nkGraphics::COMPARISON_FUNCTION::FUNCTION_LESS_EQUAL
@ FUNCTION_LESS_EQUAL
Function <= (less then or equal).
nkGraphics::COMPARISON_FUNCTION
COMPARISON_FUNCTION
Available comparison functions available during sampling (for samplers, and depth stencil states).
Definition: ComparisonFunction.h:12
nkGraphics::COMPARISON_FUNCTION::FUNCTION_GREATER_EQUAL
@ FUNCTION_GREATER_EQUAL
Function >= (geather than or equal).
nkGraphics
Encompasses all API of component NilkinsGraphics.
Definition: BoundingBox.h:7
nkGraphics::ComparisonFunctionUtils
Offers utility to work with the associated enumeration.
Definition: ComparisonFunction.h:27
nkGraphics::ComparisonFunctionUtils::toString
static nkMemory::StringView toString(COMPARISON_FUNCTION value)